image
Type
object
Summary
A control that contains a bitmapped picture.
Syntax
image
Description
Use the image object type to hold photographs, icons, and decorative elements, and to allow the user to paint.
Each image contains a bitmapped picture, which can either be imported with the import command or created using the paint tool|paint tools. An image can display either its own data, or a file specified by the image's filename property.
An image is contained in a card, group, or background. Images cannot contain other objects.
note
Animated GIFs cannot be resized in LiveCode.
Examples
hide image "Blinking Star"
export image ID 9234 to file "Test Image.jpg"
Related
keyword: templateImage, file, image, control
property: filename, imageData, resizeQuality
glossary: property, paint tool, bitmap, command, object type
Compatibility and Support
Introduced
LiveCode 1.0
OS
mac
windows
linux
ios
android
Platforms
desktop
server
mobile
Associated Syntax
Message
| Name | Summary | Syntax |
|---|---|---|
| socketError | Sent when an error occurs on a socket that causes the socket to close or to fail to open. | socketError <pSocketID>, <pErrorString> |
| deleteImage | Sent to an image just before it is removed from the stack. | deleteImage |
| mouseWithin | Sent periodically to an object while the mouse pointer is within its borders. | mouseWithin |
| dragEnd | Sent to the object a drag and drop started from, when the data is dropped. | dragEnd |
| nameChanged | Sent to an object when its name is changed. | nameChanged <pOldName>, <pNewName> |
| dragDrop | Sent to the object where data was dropped when a drag and drop finishes. | dragDrop |
| dragLeave | Sent when the mouse pointer moves out of an object during a drag and drop. | dragLeave |
| socketTimeout | Sent when an open socket, read from socket or write to socket command halts for the time specified by the socketTimeoutInterval property. | socketTimeout <pSocketID> |
| selectedObjectChanged | Sent to an object when it is selected. | selectedObjectChanged |
| dragEnter | Sent when the mouse pointer moves into an object during a drag and drop. | dragEnter |
| mouseRelease | Sent when the user releases the mouse outside the control that was clicked. | mouseRelease <pButtonNumber> |
| mouseDown | Sent when the user presses the mouse button. | mouseDown <pButtonNumber> |
| IDChanged | Sent to an image when its ID property is changed. | IDChanged <pOldID>, <pNewID> |
| mouseEnter | Sent when the mouse pointer moves into an object. | mouseEnter |
| mouseUp | Sent when the user releases the mouse button. | mouseUp <pButtonNumber> |
| dragMove | Sent when the user moves the mouse during a drag and drop. | dragMove |
| newImage | Sent to a new image right after it's created. | newImage |
| mouseStillDown | Sent periodically while the mouse button is being held down. | mouseStillDown <pButtonNumber> |
| dragStart | Sent to a control when the user clicked on it and then started to drag the mouse pointer. | dragStart |
| mouseMove | Sent when the user moves the mouse. | mouseMove <pNewMouseH>, <pNewMouseV> |
| resizeControl | Sent to a control right after the user resizes it. | resizeControl |
| mouseLeave | Sent when the mouse pointer moves out of an object. | mouseLeave |
| socketClosed | Sent when the remote system closes a socket. | socketClosed <pSocketID> |
| mouseDoubleUp | Sent when the mouse button is released at the end of a double-click. | mouseDoubleUp <pButtonNumber> |
| mouseDoubleDown | Sent when the user double-clicks. | mouseDoubleDown <pButtonNumber> |
Property
| Name | Summary | Syntax |
|---|---|---|
| frameCount | Reports the number of frames in an animated GIF image. | get the frameCount of <image> |
| size | Reports the amount of disk space taken by an object. | get the size of <object> |
| topRight | Specifies the location of the specified object's upper right corner. | set the topRight of <object> to <right>, <top> |
| formattedWidth | Reports the width needed by an object to display its full contents without scrolling. | get the formattedWidth of <object> get the formattedWidth of [<chunk> of] <field> |
| xHot | Specifies the horizontal position of the hot spot when an image is being used as a cursor. | set the xHot of <image> to <pixels> |
| script | Specifies the contents of an object's **script**. | set the script of <object> to <string> |
| borderColor | Specifies the color of an object's border. | set the borderColor of <object> to {empty | <colorName> | <RGBColor>} set the borderColor of <line> of <field> to {empty | <colorName> | <RGBColor>} |
| hilitePixel | Specifies which entry in the color table is used for the background color when an object, or text in an object, is highlighted. | set the hilitePixel of <object> to <colorNumber> |
| patterns | Specifies all the patterns of an object, in shorthand form. | set the patterns of <object> to <patternsList> |
| number | Specifies an object's position within a file, a card's position within a stack, or a control's layer on a card. | set the number of <card> to <number> get the number of <object> |
| topLeft | Specifies the location of the specified object's upper left corner. | set the topLeft of <object> to left,top |
| maskPixmapID | Specifies the window ID of the X11 pixmap used to mask an image. | set the maskPixmapID of <image> to {empty | <windowID>} |
| altID | Specifies an alternate ID for objects. | set the altID of <object> to <IDNumber> |
| right | Specifies how far an object's right edge is from the left edge of the window or screen. | set the right of <object> to <pixels> |
| focusPattern | Specifies the pattern used for an object's outline when it has the insertion point or is active focused. | set the focusPattern of <object> to {<patternNumber> | <imageID> | empty} |
| dontDither | Specifies whether 24-bit images are dithered on displays with fewer colors. | set the dontDither of <image> to {true | false} |
| topPattern | Specifies the pattern used to draw a three-D object's raised edge. | set the topPattern of <object> to {<patternNumber> | <imageID> | empty} |
| foregroundColor | Specifies the color of object text and borders. | set the foregroundColor of <object> to {empty | <colorName> | <RGBColor>} set the foregroundColor of [<chunk> of] <field> to {empty| <colorName> | <RGBColor>} |
| text | Specifies the text contained by a button or field or the binary data in an image. | set the text of {<button> | <field> | <image>} to <string> |
| borderPixel | Specifies which entry in the color table is used for the color of an object's border. | set the borderPixel of <object> to <colorNumber> |
| shadowPixel | Specifies which entry in the color table is used for the color of an object's drop shadow or the background of a scrollbar. | set the shadowPixel of <object> to <colorNumber> |
| imagePixmapID | Specifies the internal window ID of the pixmap used to redraw an image. | get the imagePixmapID of <image> |
| behavior | Allows an object to inherit its script handlers from another object. | set the behavior of <object> to {<button> | <stack>} |
| customProperties | Specifies all the custom properties of an object that are in the current customPropertySet, along with their settings. | set the customProperties of <object> to <propertiesArray> set the customProperties[<propertySet>] of <object> to <propertiesArray> |
| yHot | Specifies the vertical position of the hot spot when an image is being used as a cursor. | set the yHot of <image> to <pixels> |
| shadowColor | Specifies the color of an object's drop shadow or the background of a scrollbar. | set the shadowColor of <object> to {empty | <colorName> | <RGBColor>} |
| palindromeFrames | Specifies that a looping animated GIF plays forward and backward. | set the palindromeFrames of <image> to {true | false} |
| filename | Specifies the file associated with a player or image. | set the filename of {<image> | <player>} to {<filePath> | <URL>} |
| textSize | Specifies the point size of text displayed by an object. | set the textSize of <object> to <pointSize> set the textSize of [<chunk> of] <field> to <pointSize> |
| shadowOffset | Specifies the size and direction of an object's drop shadow. | set the shadowOffset of <object> to <pixels> |
| textFont | Specifies the font face of text in an object. | set the textFont of <object> to <fontName> [, <language>] set the textFont of [<chunk> of] <field> to <fontName> [, <language>] |
| enabled | Specifies that an object is active and responds to user action. | set the enabled of <object> to {true | false} |
| backgroundColor | Specifies an object's background color. | set the backgroundColor of <object> to {empty | <colorName> | <RGBColor>} set the backgroundColor [of <chunk>] [of <line>] of <field> to {empty| <colorName> | <RGBColor>} |
| hiliteColor | Specifies the color of the background when an object, or text in an object, is highlighted. | set the hiliteColor [of <object>] to {empty | <colorName> | <RGBColor>} |
| currentFrame | Specifies the current frame of an animated GIF. | set the currentFrame of <image> to <frameNumber> |
| resizeQuality | Specifies which method LiveCode should use to scale an image. | set the resizeQuality of <image> to <qualityValue> |
| dropShadow | Specifies the drop shadow to use for an object. | set the dropShadow of object to <propertiesArray> set the dropShadow[<propertyName>] of object to <propertyValue> |
| bottomPattern | Specifies the pattern of a three-D object's lowered edge. | set the bottomPattern of <object> to {empty | <patternNumber> | <imageID>} |
| customPropertySets | Lists all the custom property sets that can apply to an object. | get the customPropertySets of <object> |
| hilitePattern | Specifies the fill pattern used for the background when an object, or text in an object, is highlighted. | set the hilitePattern of <object> to {<patternNumber> | <imageID> | empty} |
| visible | Specifies whether an object can be seen or is hidden. | set the [effective] visible of <object> to {true | false} |
| shadowPattern | Specifies the pattern of an object's drop shadow. | set the shadowPattern of <object> to {<patternNumber> | <imageID> | empty} |
| layer | Specifies the back-to-front order of objects on a card or the order of cards in a stack. | set the layer of <object> to {<layerNumber> | top | bottom} |
| backgroundPattern | The **backgroundPattern** specifies the pattern used to draw an object's background. | set the backgroundPattern of <object> to {<patternNumber> | <imageID> | empty} |
| metadata of image | The metadata property of an image is a read only array of metadata from the image file. | put the metadata of <imageObject> into <metadataArray> |
| topColor | Specifies the color of a three-D object's raised edge. | set the topColor of <object> to {empty | <colorName> | <RGBColor>} |
| bottom | Specifies how far an object's bottom edge is from the top of the window or screen. | set the bottom of <object> to <number> |
| borderPattern | Specifies the pattern of an object's border. | set the borderPattern of <object> to {empty | <patternNumber> | <imageID>} |
| colorOverlay | Specifies the color overlay to use for an object. | set the colorOverlay of object to <propertiesArray> set the colorOverlay[<propertyName>] of object to <propertyValue> |
| height | Specifies the distance from an object's top edge to its bottom edge. | set the height of <object> to <numberOfPixels> |
| outerGlow | Specifies the outer glow to use for an object. | set the outerglow of object to <propertiesArray> set the outerglow[<propertyName>] of object to <propertyValue> |
| constantMask | Specifies whether animated GIFs ignore changes in the mask data when displaying the GIF. | set the constantMask of <image> to {true | false} |
| bottomPixel | Specifies which entry in the color table is used for the color of a three-D object's lowered edge. | set the bottomPixel of <object> to <colorNumber> |
| pixels | The **pixels** property is not implemented and is reserved. | pixels |
| maskData | Specifies which pixels of an image are displayed. | set the maskData of <image> to <binaryData> |
| alwaysBuffer | Determines whether the contents of windows, players, and images are buffered offscreen. | set the alwaysBuffer of {<stack> | <image> | <player>} to {true | false} |
| top | Specifies how far an object's top edge is from the top of the window or screen. | set the top of <object> to <numberOfPixels> |
| rectangle | Specifies the area within which an object is drawn. | set the rectangle of <object> to <left>, <top>, <right>, <bottom> get the [effective] rectangle of <object> |
| invisible | Specifies whether an object is hidden. | set the invisible of <object> to {true | false} get the [effective] invisible of <object> |
| layerMode | Specifies whether an object is dynamic or static. | set the layerMode of <object> to <mode> get the [effective] layerMode of <object> |
| hotSpot | Specifies the location of the hot spot when an image is being used as a cursor. | set the hotSpot of <image> to <point> |
| topPixel | Specifies which entry in the color table is used for the color of a three-D object's raised edge. | set the topPixel of <object> to <colorNumber> |
| bottomRight | Specifies the location of the specified object's lower right corner. | set the bottomRight of <object> to right,bottom |
| foregroundPixel | Specifies which entry in the color table is used for an object's text and borders. | set the foregroundPixel of <object> to <colorNumber> |
| unicodeTooltip | Specifies the explanatory text (UTF-16 string) that pops up in a small box when the user points to an object. | set the unicodeTooltip of object to <unicodeString> |
| bottomLeft | Specifies the location of the specified object's lower left corner. | set the bottomLeft of <object> to <left>, <bottom> |
| innerShadow | Specifies the inner shadow to use for an object. | set the innerShadow of object to <propertiesArray> set the innerShadow[<propertyName>] of object to <propertyValue> |
| location | Specifies where an object is. | set the location of <object> to <point> |
| left | Specifies how far an object's left edge is from the left edge of the window or screen. | set the left of <object> to <numberOfPixels> |
| showFocusBorder | Displays a border around the active control. | set the showFocusBorder of <control> to {true | false} |
| disabled | Specifies that an object is dimmed and does not respond to user action. | set the disabled of <object> to {true | false} |
| imageData | Specifies the binary data that makes up the picture in an image object. | set the imageData of <image> to <binaryData> |
| repeatCount | Specifies the number of times an animated GIF image repeats. | set the repeatCount of <image> to <numberOfCycles> |
| selected | Specifies whether an object is **selected**. | set the selected of <object> to {true | false} |
| properties | Specifies some of an object's **properties** and their current values. | set the properties of <object> to <propertiesArray> |
| colors | Specifies all the colors of an object, in shorthand form. | set the colors of <object> to <colorsList> |
| ID | Reports the unique ID number assigned to an object. | set the ID of {image | stack} to <number> get the [{ long | abbreviated | short }] ID of <object> |
| magnify | Shows or hides a window showing a magnified view of an image. | set the magnify of <image> to {true | false} |
| customPropertySet | Specifies a set of custom properties applied to an object. | set the customPropertySet of object to {setName | empty} |
| backgroundPixel | Specifies which entry in the color table is used for an object's background color. | set the backgroundPixel of <object> to <colorNumber> |
| alphaData | Specifies the binary data that makes up the alpha channel of the picture in an image object. | set the alphaData of <image> to <binaryData> |
| centerRect | Specifies a region of pixels that should be stretched when the image is stretched. | set the centerRect[angle] of <image> to <rectangle> get the [effective] centerRect[angle] of <image> |
| focusPixel | Specifies which entry in the color table is used for the color of an object's outline when it has the insertion point or is active focused. | set the focusPixel of <object> to <colorNumber> |
| bottomColor | Specifies the color of a three-D object's lowered edge. | set the bottomColor of <object> to {empty | <colorName> | <RGBColor>} |
| textStyle | Specifies the style or styles applied to text in an object. | set the textStyle of <object> to {empty | plain | <stylesList>} set the textStyle of [<chunk> of] <field> to {empty | plain | <stylesList>} set the textStyle[<style>] of object to {true | false} |
| threeD | Specifies whether an object appears to stick out of or recede into the screen. | set the threeD of <object> to {true | false} |
| width | The **width** of an object is the distance from its left edge to its right edge. | set the width of <object> to <numberOfPixels> |
| showBorder | Specifies whether an outline is drawn around an object. | set the showBorder of <object> to {true | false} |
| innerGlow | Specifies the inner glow to use for an object | set the innerGlow of object to <propertiesArray> set the innerGlow[<propertyName>] of object to <propertyValue> |
| name | Specifies the name of an object. | set the [{ long | abbreviated | short }] name of <object> to <string> get the name |
| owner | Reports which object is next in the object hierarchy. | get the [{ long | abbreviated | short }] owner of <object> |
| formattedHeight | Reports the height needed by an object to display its full contents without scrolling. | get the formattedHeight of <object> get the formattedHeight of [<chunk> of] <field> |
| focusColor | Specifies the color of the outline around the active control or the field with the insertion point. | set the focusColor of <object> to {empty | <colorName> | <RGBColor>} |
| customKeys | Lists the names of all the custom properties of an object. | set the customKeys of <object> to {<propertiesList> | empty} |
| foregroundPattern | Specifies the pattern used for object text and borders. | set the foregroundPattern of <object> to {<patternNumber> | <imageID> | empty} set the foregroundPattern of [<chunk> of] <field> to {<patternNumber> | <imageID> | empty} |